
package fileutil

import (
	"os"
	"path/filepath"
	"sort"
	"strings"
	"time"

	"go.uber.org/zap"
)

// fileutil.PurgeFile （） 函数中会定期查询指定的 目录，并统计指定后缀的文件个数 ，如果文
// 件个数超过指定的上限，则进行清理操作
func PurgeFile(lg *zap.Logger, dirname string, suffix string, max uint, interval time.Duration, stop <-chan struct{}) <-chan error {
	return purgeFile(lg, dirname, suffix, max, interval, stop, nil, nil)
}

func PurgeFileWithDoneNotify(lg *zap.Logger, dirname string, suffix string, max uint, interval time.Duration, stop <-chan struct{}) (<-chan struct{}, <-chan error) {
	doneC := make(chan struct{})
	errC := purgeFile(lg, dirname, suffix, max, interval, stop, nil, doneC)
	return doneC, errC
}

// purgeFile是purgeFile的内部实现，如果非nil，它可以将清除的文件发布到purgec。
// 如果donec为非nil，函数将关闭它以通知其退出。
func purgeFile(lg *zap.Logger, dirname string, suffix string, max uint, interval time.Duration, stop <-chan struct{}, purgec chan<- string, donec chan<- struct{}) <-chan error {
	if lg == nil {
		lg = zap.NewNop()
	}
	errC := make(chan error, 1)
	go func() {	// 启动一个后台 goroutine
		if donec != nil {
			defer close(donec)
		}
		for {	// 查找目标目 录下的子文件名称 ，其中还会对根据文件名称进行排序
			fnames, err := ReadDir(dirname)
			if err != nil {
				errC <- err
				return
			}
			newfnames := make([]string, 0)
			for _, fname := range fnames {	// 根据指定的后级对文件名称进行过滤
				if strings.HasSuffix(fname, suffix) {
					newfnames = append(newfnames, fname)
				}
			}
			sort.Strings(newfnames)	// 排序
			fnames = newfnames
			for len(newfnames) > int(max) {	// 指定后级的文件个数是否超过上限
				f := filepath.Join(dirname, newfnames[0])
				l, err := TryLockFile(f, os.O_WRONLY, PrivateFileMode)	// 获取文件锁
				if err != nil {
					break
				}
				if err = os.Remove(f); err != nil {	// 删除文件
					errC <- err
					return
				}
				if err = l.Close(); err != nil {	// 关闭对应的文件句柄，
					lg.Warn("failed to unlock/close", zap.String("path", l.Name()), zap.Error(err))
					errC <- err
					return
				}
				lg.Info("purged", zap.String("path", f))
				newfnames = newfnames[1:]	// 从 newfnames 中清除指定的文件

			}
			if purgec != nil {
				for i := 0; i < len(fnames)-len(newfnames); i++ {
					purgec <- fnames[i]
				}
			}
			select {	// 阻塞指定的时间间隔
			case <-time.After(interval):
			case <-stop:	// 当前节点正在关闭，则退出该 goroutine
				return
			}
		}
	}()
	return errC
}
